/*
 * Copyright 1993-2012 NVIDIA Corporation.  All rights reserved.
 *
 * NOTICE TO LICENSEE:
 *
 * This source code and/or documentation ("Licensed Deliverables") are
 * subject to NVIDIA intellectual property rights under U.S. and
 * international Copyright laws.
 *
 * These Licensed Deliverables contained herein is PROPRIETARY and
 * CONFIDENTIAL to NVIDIA and is being provided under the terms and
 * conditions of a form of NVIDIA software license agreement by and
 * between NVIDIA and Licensee ("License Agreement") or electronically
 * accepted by Licensee.  Notwithstanding any terms or conditions to
 * the contrary in the License Agreement, reproduction or disclosure
 * of the Licensed Deliverables to any third party without the express
 * written consent of NVIDIA is prohibited.
 *
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, NVIDIA MAKES NO REPRESENTATION ABOUT THE
 * SUITABILITY OF THESE LICENSED DELIVERABLES FOR ANY PURPOSE.  IT IS
 * PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.
 * NVIDIA DISCLAIMS ALL WARRANTIES WITH REGARD TO THESE LICENSED
 * DELIVERABLES, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
 * NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, IN NO EVENT SHALL NVIDIA BE LIABLE FOR ANY
 * SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY
 * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
 * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THESE LICENSED DELIVERABLES.
 *
 * U.S. Government End Users.  These Licensed Deliverables are a
 * "commercial item" as that term is defined at 48 C.F.R. 2.101 (OCT
 * 1995), consisting of "commercial computer software" and "commercial
 * computer software documentation" as such terms are used in 48
 * C.F.R. 12.212 (SEPT 1995) and is provided to the U.S. Government
 * only as a commercial end item.  Consistent with 48 C.F.R.12.212 and
 * 48 C.F.R. 227.7202-1 through 227.7202-4 (JUNE 1995), all
 * U.S. Government End Users acquire the Licensed Deliverables with
 * only those rights set forth herein.
 *
 * Any use of the Licensed Deliverables in individual and commercial
 * software must include, in the user documentation and internal
 * comments to the code, the above Disclaimer and U.S. Government End
 * Users Notice.
 */

#if !defined(__CUDA_PROFILER_API_H__)
#define __CUDA_PROFILER_API_H__

#include "driver_types.h"
#if defined(__cplusplus)
extern "C" {
#endif /* __cplusplus */

/**
 * \ingroup CUDART
 * \defgroup CUDART_PROFILER Profiler Control
 * This section describes the profiler control functions of the CUDA runtime
 * application programming interface.
 *
 * @{
 */

/**
 * \brief Initialize the profiling.
 *
 * Using this API user can specify the configuration file, output file and
 * output file format. This API is generally used to profile different set
 * of counters by looping the kernel launch.
 * \p configFile parameter can be used to select profiling options including
 * profiler counters. Refer the "Command Line Profiler" section in the 
 * "Compute Visual Profiler User Guide" for supported profiler options and 
 * counters.
 *
 * Configurations defined initially by environment variable settings are
 * overwritten by cudaProfilerInitialize().
 *
 * Limitation: Profiling APIs do not work when the application is running
 * with any profiler tool such as Compute Visual Profiler. User must handle
 * error ::cudaErrorProfilerDisabled returned by profiler APIs if application
 * is likely to be used with any profiler tool. 
 *
 * Typical usage of the profiling APIs is as follows: 
 *
 * for each set of counters\n
 * {\n
 *      cudaProfilerInitialize(); //Initialize profiling,set the counters/options in 
 * the config file \n
 *      ...\n
 *      cudaProfilerStart(); \n
 *      // code to be profiled \n
 *      cudaProfilerStop();\n
 *      ...\n
 *      cudaProfilerStart(); \n
 *      // code to be profiled \n
 *      cudaProfilerStop();\n
 *      ...\n
 * }\n
 *
 *
 * \param configFile - Name of the config file that lists the counters for 
 * profiling.
 * \param outputFile - Name of the outputFile where the profiling results
 * will be stored.
 * \param outputMode - outputMode, can be ::cudaKeyValuePair OR ::cudaCSV.
 *
 * \return
 * ::cudaSuccess,
 * ::cudaErrorInvalidValue,
 * ::cudaErrorProfilerDisabled
 * \notefnerr
 *
 * \sa ::cudaProfilerStart, ::cudaProfilerStop
 */
extern __host__ cudaError_t CUDARTAPI cudaProfilerInitialize(const char *configFile, 
                                                             const char *outputFile, 
                                                             cudaOutputMode_t outputMode);

/**
 * \brief Start the profiling.
 *
 * This API is used in conjunction with cudaProfilerStop to selectively profile 
 * subsets of the CUDA program.
 * Profiler must be initialized using cudaProfilerInitialize() before making a 
 * call to cudaProfilerStart(). API returns an error 
 * ::cudaErrorProfilerNotInitialized if it is called without initializing profiler.
 *
 * \return
 * ::cudaSuccess,
 * ::cudaErrorProfilerDisabled,
 * ::cudaErrorProfilerAlreadyStarted,
 * ::cudaErrorProfilerNotInitialized
 * \notefnerr
 *
 * \sa ::cudaProfilerInitialize, ::cudaProfilerStop
 */
extern __host__ cudaError_t CUDARTAPI cudaProfilerStart(void);

/**
 * \brief Stop the profiling.
 *
 * This API is used in conjunction with cudaProfilerStart to selectively profile 
 * subsets of the CUDA program.
 * Profiler must be initialized using cudaProfilerInitialize() before making a 
 * call to cudaProfilerStop().API returns an error ::cudaErrorProfilerNotInitialized 
 * if it is called without initializing profiler.
 *
 * \return
 * ::cudaSuccess,
 * ::cudaErrorProfilerDisabled,
 * ::cudaErrorProfilerAlreadyStopped,
 * ::cudaErrorProfilerNotInitialized
 * \notefnerr
 *
 * \sa ::cudaProfilerInitialize, ::cudaProfilerStart
 */
extern __host__ cudaError_t CUDARTAPI cudaProfilerStop(void);

/** @} */ /* END CUDA_PROFILER */

#if defined(__cplusplus)
}
#endif /* __cplusplus */

#endif /* !__CUDA_PROFILER_API_H__ */
